<!DOCTYPE html>
<html>
<head>
	<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
	<meta name="generator" content="ApiGen 2.8.0" />

	<title>Class deposits | PhpProject1</title>

	<script type="text/javascript" src="resources/combined.js?2802348487"></script>
	<script type="text/javascript" src="elementlist.js?1053356144"></script>
	<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?3505392360" />

</head>

<body>
<div id="left">
	<div id="menu">
		<a href="index.html" title="Overview"><span>Overview</span></a>


		<div id="groups">
		</div>



		<div id="elements">
			<h3>Classes</h3>
			<ul>
				<li class="active"><a href="class-deposits.html">deposits</a></li>
				<li><a href="class-planets.html">planets</a></li>
				<li><a href="class-terrain.html">terrain</a></li>
			</ul>





		</div>
	</div>
</div>

<div id="splitter"></div>

<div id="right">
<div id="rightInner">
	<form id="search">
		<input type="hidden" name="cx" value="" />
		<input type="hidden" name="ie" value="UTF-8" />
		<input type="text" name="q" class="text" />
		<input type="submit" value="Search" />
	</form>

	<div id="navigation">
		<ul>
			<li>
				<a href="index.html" title="Overview"><span>Overview</span></a>
			</li>
			<li class="active">
<span>Class</span>			</li>
		</ul>
		<ul>
			<li>
				<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
			</li>
		</ul>
		<ul>
		</ul>
	</div>

<div id="content" class="class">
	<h1>Class deposits</h1>


	<div class="description">
	
<p>Handles displaying, creating and editing all of the deposits.</p>

	</div>









	<div class="info">
		
		
		
		

				<b>Author:</b>
				Charles<br />
		<b>Located at</b> <a href="source-class-deposits.html#8-373" title="Go to source code">library/deposits.php</a><br />
	</div>



	<table class="summary" id="methods">
	<caption>Methods summary</caption>
	<tr data-order="drawDepositMap" id="_drawDepositMap">

		<td class="attributes"><code>
			 public 
			
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_drawDepositMap">#</a>
		<code><a href="source-class-deposits.html#15-56" title="Go to source code">drawDepositMap</a>( <span>integer <var>$planetID</var></span>, <span>integer <var>$planetSize</var></span> )</code>

		<div class="description short">
			
<p>Description: Displays Div map of deposits, ontop of terrain</p>

		</div>

		<div class="description detailed hidden">
			
<p>Description: Displays Div map of deposits, ontop of terrain</p>



				<h4>Parameters</h4>
				<div class="list"><dl>
					<dt><var>$planetID</var></dt>
					<dd><code>integer</code><br>$planetID</dd>
					<dt><var>$planetSize</var></dt>
					<dd><code>integer</code><br>$planetSize</dd>
				</dl></div>





		</div>
		</div></td>
	</tr>
	<tr data-order="createDeposit" id="_createDeposit">

		<td class="attributes"><code>
			 public 
			
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_createDeposit">#</a>
		<code><a href="source-class-deposits.html#58-97" title="Go to source code">createDeposit</a>( <span>string <var>$name</var></span>, <span>integer <var>$size</var></span>, <span>string <var>$planet</var></span>, <span>string <var>$coordinates</var></span>, <span>integer <var>$type</var></span> )</code>

		<div class="description short">
			
<p>Description: Creates deposit into database and redirects to
listDeposits.php</p>

		</div>

		<div class="description detailed hidden">
			
<p>Description: Creates deposit into database and redirects to
listDeposits.php</p>



				<h4>Parameters</h4>
				<div class="list"><dl>
					<dt><var>$name</var></dt>
					<dd><code>string</code><br>$name</dd>
					<dt><var>$size</var></dt>
					<dd><code>integer</code><br>$size</dd>
					<dt><var>$planet</var></dt>
					<dd><code>string</code><br>$planet</dd>
					<dt><var>$coordinates</var></dt>
					<dd><code>string</code><br>$coordinates</dd>
					<dt><var>$type</var></dt>
					<dd><code>integer</code><br>$type</dd>
				</dl></div>

				<h4>Returns</h4>
				<div class="list">
					<code></code><br>Redirects user.<br />
				</div>




		</div>
		</div></td>
	</tr>
	<tr data-order="listDeposits" id="_listDeposits">

		<td class="attributes"><code>
			 public 
			
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_listDeposits">#</a>
		<code><a href="source-class-deposits.html#140-173" title="Go to source code">listDeposits</a>( )</code>

		<div class="description short">
			
<p>Description: Prints HTML table of all deposits.</p>

		</div>

		<div class="description detailed hidden">
			
<p>Description: Prints HTML table of all deposits.</p>








		</div>
		</div></td>
	</tr>
	<tr data-order="editDeposit" id="_editDeposit">

		<td class="attributes"><code>
			 public 
			
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_editDeposit">#</a>
		<code><a href="source-class-deposits.html#175-275" title="Go to source code">editDeposit</a>( <span>integer <var>$id</var></span>, <span>string <var>$name</var></span>, <span>integer <var>$size</var></span>, <span>string <var>$coordinates</var></span>, <span>string <var>$type</var></span> )</code>

		<div class="description short">
			
		</div>

		<div class="description detailed hidden">
			
<p>Description: Changes corodinate, name, size, or type of Raw material</p>



				<h4>Parameters</h4>
				<div class="list"><dl>
					<dt><var>$id</var></dt>
					<dd><code>integer</code><br>$id</dd>
					<dt><var>$name</var></dt>
					<dd><code>string</code><br>$name</dd>
					<dt><var>$size</var></dt>
					<dd><code>integer</code><br>$size</dd>
					<dt><var>$coordinates</var></dt>
					<dd><code>string</code><br>$coordinates</dd>
					<dt><var>$type</var></dt>
					<dd><code>string</code><br>$type</dd>
				</dl></div>





		</div>
		</div></td>
	</tr>
	<tr data-order="deleteDeposit" id="_deleteDeposit">

		<td class="attributes"><code>
			 public 
			
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_deleteDeposit">#</a>
		<code><a href="source-class-deposits.html#278-292" title="Go to source code">deleteDeposit</a>( <span>integer <var>$depositID</var></span> )</code>

		<div class="description short">
			
<p>Description: Deletes deposit where depositID = id</p>

		</div>

		<div class="description detailed hidden">
			
<p>Description: Deletes deposit where depositID = id</p>



				<h4>Parameters</h4>
				<div class="list"><dl>
					<dt><var>$depositID</var></dt>
					<dd><code>integer</code><br>$depositID</dd>
				</dl></div>





		</div>
		</div></td>
	</tr>
	<tr data-order="getDeposit" id="_getDeposit">

		<td class="attributes"><code>
			 public 
			array
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_getDeposit">#</a>
		<code><a href="source-class-deposits.html#295-315" title="Go to source code">getDeposit</a>( <span>integer <var>$planetID</var></span>, <span>string <var>$coordinates</var></span> )</code>

		<div class="description short">
			
<p>Description: Querys deposit database and returns array from specified ID and
coordinate.</p>

		</div>

		<div class="description detailed hidden">
			
<p>Description: Querys deposit database and returns array from specified ID and
coordinate.</p>



				<h4>Parameters</h4>
				<div class="list"><dl>
					<dt><var>$planetID</var></dt>
					<dd><code>integer</code><br>$planetID</dd>
					<dt><var>$coordinates</var></dt>
					<dd><code>string</code><br>$coordinates</dd>
				</dl></div>

				<h4>Returns</h4>
				<div class="list">
					<code>array</code><br />
				</div>




		</div>
		</div></td>
	</tr>
	<tr data-order="depositImage" id="_depositImage">

		<td class="attributes"><code>
			 public 
			string
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_depositImage">#</a>
		<code><a href="source-class-deposits.html#318-351" title="Go to source code">depositImage</a>( <span>string <var>$type</var></span> )</code>

		<div class="description short">
			
		</div>

		<div class="description detailed hidden">
			
<p>Description: Takes string argument and returns image url.</p>



				<h4>Parameters</h4>
				<div class="list"><dl>
					<dt><var>$type</var></dt>
					<dd><code>string</code><br>$type</dd>
				</dl></div>

				<h4>Returns</h4>
				<div class="list">
					<code>string</code><br />
				</div>




		</div>
		</div></td>
	</tr>
	<tr data-order="depositInfo" id="_depositInfo">

		<td class="attributes"><code>
			 public 
			array
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_depositInfo">#</a>
		<code><a href="source-class-deposits.html#354-371" title="Go to source code">depositInfo</a>( <span>integer <var>$id</var></span> )</code>

		<div class="description short">
			
		</div>

		<div class="description detailed hidden">
			
<p>Description: Takes deposit id and returns array</p>



				<h4>Parameters</h4>
				<div class="list"><dl>
					<dt><var>$id</var></dt>
					<dd><code>integer</code><br>$id</dd>
				</dl></div>

				<h4>Returns</h4>
				<div class="list">
					<code>array</code><br />
				</div>




		</div>
		</div></td>
	</tr>
	</table>


















</div>

	<div id="footer">
		PhpProject1 API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
	</div>
</div>
</div>
</body>
</html>
